home *** CD-ROM | disk | FTP | other *** search
/ PC-SIG: World of Education / PC-SiG's World of Education.iso / wor / disk2347.zip / INDEXER.DOC < prev    next >
Text File  |  1991-04-19  |  22KB  |  481 lines
  1.  
  2.  
  3.  
  4.  
  5.                                   Index Maker
  6.                                   Version 2.0
  7.                                  User's Manual
  8.  
  9.                               by Bruce W. Muckala
  10.                        Copyright 1990 by Bruce W. Muckala
  11.  
  12.                                 Itasca Softworks
  13.                                  Rt. 1, Box 408
  14.                                Bagley, MN  56621
  15.      
  16.  
  17.                                Table of Contents
  18.  
  19.      Introduction ................................................... 1
  20.      Setting Up ..................................................... 2
  21.      Status Display ................................................. 3
  22.      Creating an Index .............................................. 4
  23.      Selecting Files ................................................ 5
  24.      Word Lists
  25.              Creating a Word List ................................... 6
  26.              Loading a Word List File ............................... 6
  27.              Viewing a Word List .................................... 7
  28.              Saving a Word List ..................................... 7
  29.      Selecting Page Options ......................................... 8
  30.      Indexing
  31.              Compiling the Index .................................... 9
  32.              Viewing the Index ...................................... 9
  33.              Printing the Index ..................................... 9
  34.      Menus
  35.              Index Maker Menus ...................................... 10
  36.      Appendix
  37.              Index Structure ........................................ 11
  38.              Program Files .......................................... 11
  39.              Registration Form ...................................... 12
  40.      Index .......................................................... 13
  41.      
  42.      ============================================================  Page 1 ===
  43.      Introduction
  44.      ========================================================================
  45.  
  46.      Creating an index to a document is a time-consuming process.  Although
  47.      creating a complete index is considered an art, using a computer utility
  48.      will greatly decrease the amount of time required in making that complete
  49.      index.
  50.  
  51.      Index Maker is a utility program for creating an index of your source
  52.      document based on words you wish to have indexed.  Index Maker will index
  53.      files in ASCII format only.  It will index up to 500 words with a maximum
  54.      of 50 page citations per word.
  55.  
  56.      Index Maker is NOT "Public Domain" and it is NOT "Freeware."  You are free
  57.      to use this program without any feeling of obligation for payment to the
  58.      author FOR REVIEW PURPOSES ONLY.  However, if you find this program useful
  59.      and use it, you are required to become a registered user of the program by
  60.      sending a $45.00 registration fee to:
  61.  
  62.                                 Itasca Softworks
  63.                                  Rt. 1, Box 408
  64.                                Bagley, MN  56621
  65.  
  66.      Registered users are notified of the availability of additional
  67.      enhancements at no additional fee.  You may freely distribute Index Maker
  68.      to friends and consorts as long as you do not charge for the program.
  69.  
  70.                  Program (C) Copyright 1990 by Bruce W. Muckala
  71.      Index Maker was written and compiled using Microsoft's QuickBASIC (TM)
  72.                              Compiler, Version 4.1.
  73.      
  74.      ===========================================================  Page 2   ===
  75.      Setting Up & Getting Started
  76.      =========================================================================
  77.  
  78.      The requirements for using Index Maker are:
  79.  
  80.      1.  an IBM PC, XT, AT, or compatible computer with at least 256k of memory.
  81.      2.  at least one disk drive (two is preferrable, one for the program and
  82.          one for index files.)
  83.      3.  an 80 column monitor either color or monochrome.
  84.      4.  256k of RAM memory.
  85.      5.  DOS 3.0 or later.
  86.      6.  a printer is optional for printing indexes.
  87.  
  88.      Make a backup copy of the disk with Index Maker and associated files.  Use
  89.      this disk as your working copy.  Always make backups of your index files to
  90.      avoid unpleasantness if your original is somehow damaged.
  91.  
  92.      If you have formatted your backup disk using the "/s" option then it is
  93.      "self-starting" - the computer may be started after placing the disk into
  94.      the A drive.  The file AUTOEXEC.BAT will automatically load and run Index
  95.      Maker after prompting for the date and time.
  96.  
  97.      This file - INDEXER.DOC - is not required on your working copy.  You may
  98.      delete it from your working disk.
  99.  
  100.      To install Index Maker on a hard disk, place the distribution disk in drive
  101.      A.  Next, create a sub-directory on your hard disk named INDEX by typing MD
  102.      INDEX <RETURN>.  Then type COPY A:*.* C:\INDEX.  Substitute your hard disk
  103.      drive letter for C in the previous instructions if you are using a
  104.      different disk drive designation.
  105.  
  106.      To begin using Index Maker type INDEXER <RETURN> at the DOS prompt.  The
  107.      program will load and the title screen will be displayed.
  108.      
  109.      ===========================================================  Page 3   ===
  110.      Status Display
  111.      =========================================================================
  112.  
  113.      The status of the source file and index is displayed in the Status Section
  114.      located in the upper right hand corner of the screen.
  115.  
  116.      Line #:                    [the line currently being indexed]
  117.      Word #:                    [the words being parsed in the current line]
  118.      Page #:                    [the current page determined by Page Options]
  119.  
  120.      Words to be Indexed:       [the total number of words in the Word List]
  121.      Total Words Indexed:       [the total number of words actually found in
  122.                                  the source file]
  123.      Total Words in File:       [the actual number of words in the source file]
  124.  
  125.      During the compilation of the index, a message is displayed above Line #:
  126.      showing the stage of the indexing.  There are two passes through the file.
  127.      The first locates all the words found in the word list and stores them in a
  128.      temporary file (named DATAFILE) which is later deleted.  The second pass
  129.      locates all the pages the words are found on.  Following the second pass
  130.      the index file is written to disk.
  131.      
  132.      ===========================================================  Page 4   ===
  133.      Basic Steps to Creating an Index with Index Maker
  134.      =========================================================================
  135.  
  136.      1.  Prepare the Source File
  137.  
  138.      Begin to prepare the source file by making sure it is saved in ASCII
  139.      format.  Most, if not all, word processors have an option to save files in
  140.      this format.  Saving a file in ASCII format will not save any character
  141.      formatting such as bold or underline type codes.  Only the actual text of
  142.      the document is saved along with tabs, carriage returns, and page breaks
  143.      (see Page Options below for more on page breaks.)
  144.  
  145.      Next, make sure your file is saved with an extension of DOC.  These are the
  146.      only files Index Maker will display to choose from in it's File Selection
  147.      Screen.  To use files with other file extensions, you will have to type in
  148.      the complete file name and extension.  To rename a file with the extension
  149.      DOC, the example below shows how to rename a file called MYFILE.TXT:
  150.  
  151.      At the DOS prompt > type REN MYFILE.TXT MYFILE.DOC and press <RETURN>.
  152.      This would rename the file MYFILE.TXT as MYFILE.DOC.  See your DOS manual
  153.      for more complete information on the REN (Rename) command.
  154.  
  155.      2.  Load Index Maker
  156.  
  157.      Load Index Maker by typing INDEXER at the DOS prompt.
  158.  
  159.      3.  Choose Disk Drive from the File menu
  160.  
  161.      Select Disk Drive from the File menu and type in the name of the disk drive
  162.      to be used.
  163.  
  164.      4.  Choose Open ASCII File to be Indexed
  165.  
  166.      Choose this option to open the source file to be indexed.
  167.  
  168.      Type in the file name and press <RETURN>. You may view a list of files by
  169.      pressing <RETURN> without entering a file name.  On the resulting window,
  170.      use the arrow keys to highlight the source file and then press <RETURN>.
  171.      (See Selecting Files.)
  172.  
  173.      5.  Load or Create a Word List
  174.  
  175.      Word list files created from a text processor must have an extension of
  176.      .WRD.
  177.  
  178.      6.  Select the option desired to determine page breaks - either by the
  179.          number of lines per page or a form feed character.
  180.  
  181.      7.  Choose Compile the Index from the Compile menu.
  182.  
  183.      Once the index is compiled you may either view it or print it.  At any time
  184.      you may add new words to the word list and re-compile the index.  The index
  185.      is saved in an ASCII disk file with the name of your source file and the
  186.      extension .IND.  You may load this file into your text processor to further
  187.      edit the index.
  188.      
  189.      ============================================================  Page 5 ===
  190.      Selecting Files
  191.      ========================================================================
  192.  
  193.      To load a word list or source file from the File Selection window, use the
  194.      up and down arrows to highlight the file names displayed.  When you have
  195.      highlighted a file you wish to load, press the <RETURN> key.  Pressing the
  196.      Home key moves to the first file name in the upper left and pressing the
  197.      End key moves the highlight to the last file in the list.
  198.  
  199.      To cancel a file selection, press the Esc key.
  200.  
  201.      Any files with an extension of .WRD will be displayed when selecting a word
  202.      list file and any file with an extension of .DOC will be displayed when
  203.      selecting a source file.
  204.      
  205.      ==========================================================  Page 6   ===
  206.      Word Lists
  207.      ========================================================================
  208.  
  209.      Loading a Word List into Memory
  210.  
  211.      Choose Load Word List from the Word Menu to load a previously saved list of
  212.      words.  You do not have to create a word list using Index Maker.  You may
  213.      create a list of words using any text processor.  The only conditions on
  214.      this list for Index Maker to load it is that each word in the list must end
  215.      with a carriage return and that the file have an extension of .WRD.
  216.  
  217.      To load the list, type in the word list's file name and press <RETURN>.
  218.      The disk drive that will be searched for the file name will be the same one
  219.      selected in opening a source file.  If you wish, you may press the <RETURN>
  220.      key when prompted for a file name and the File Selection window will appear
  221.      with any files with an extension of .WRD.  You may then select from these
  222.      files using the arrow keys.
  223.  
  224.      Creating a Word List
  225.  
  226.      To create a list of words to index choose Create Word List from the Word
  227.      Menu.  You will be given two additional choices; to create a new word list
  228.      or to add words to a list you may have already loaded into the computer's
  229.      memory.
  230.  
  231.      Start New Word List
  232.  
  233.      Select this option when you wish to define words to be indexed.  You will
  234.      be prompted for a word which you should type in just as you wish it
  235.      displayed in the index.  The case of the word is irrelevant to Index
  236.      Maker's search for it, though it will be displayed in the created index
  237.      just as you typed it.  The exact word will be found.  For example:  if you
  238.      type in "file" the word "files" will not be indexed.  If you type in "file
  239.      name", neither word will be indexed.
  240.  
  241.      After you have typed in all the words you wish to index, press the F2 key
  242.      to exit the creation of a word list.
  243.  
  244.      Add Words to Current List
  245.  
  246.      If you already have a word list created or loaded into the computer's
  247.      memory, you may choose this option to add additional words to the word
  248.      list.  Enter words as described above and press the F2 key when complete.
  249.      
  250.      ==========================================================  Page 7   ===
  251.      Word Lists
  252.      ========================================================================
  253.  
  254.      Viewing the Word List
  255.  
  256.      To view the list of words already entered or loaded, choose View Word List
  257.      from the Word Menu.  The words will be displayed on the screen.  If the
  258.      list is longer than may be displayed, press the Pg Up or Pg Dn keys to
  259.      display another screen full or press Esc to cancel viewing the words.
  260.  
  261.      Saving the Word List
  262.  
  263.      To save a word list to disk, choose Save Word List from the Word Menu.  You
  264.      will be prompted for a file name.  Type in the word list's file name and
  265.      press <RETURN>.  No extension is needed as the program will assign all word
  266.      lists the extension of .WRD.
  267.  
  268.      
  269.      ===========================================================  Page 8   ===
  270.      Page Options
  271.      =========================================================================
  272.  
  273.      Choose Page Options to determine how page breaks will be determined during
  274.      the compilation of the index.  There are two ways you may do this.  If your
  275.      text processor has the option to mark page breaks in an ASCII document
  276.      (ASCII character 12 - form feed) this is the easiest way.  Whenever a form
  277.      feed character is encountered in a line of text, the page count is
  278.      incremented.  You may also choose to set the number of lines per page by
  279.      entering a digit.  This option works just as well except you should test
  280.      the document beforehand to assure the correct pagination.  Otherwise, you
  281.      index pages will not correspond to the actual pages printed.
  282.  
  283.      To enter an option, choose Page Options from the File Menu.  Enter an F for
  284.      form feed character or an L to enter a line number.  Pressing Esc will exit
  285.      the option.
  286.  
  287.      The form feed option is the default.
  288.      
  289.      ===========================================================  Page 9   ===
  290.      Compiling the Index
  291.      =========================================================================
  292.  
  293.      Compiling the Index
  294.  
  295.      Once you have selected the ASCII source file to be indexed, loaded or
  296.      created a word list, and selected the method of determining page breaks,
  297.      you are ready to compile the index.  Select Compile the Index from the
  298.      Compile menu.  The index will be compiled onto the default disk drive you
  299.      specified when choosing Disk Drive from the File menu.
  300.  
  301.      Be sure you have plenty of empty disk space for the temporary files created
  302.      during the index process.  A good base is at least twice the size of the
  303.      source file.
  304.  
  305.      All indexes are saved as an ASCII disk file using the name of your source
  306.      file and the extension .IND.
  307.  
  308.      If you created an index and then added more words to the word list, simply
  309.      re-compile the index and a new one will replace the old one.
  310.  
  311.      Viewing the Index
  312.  
  313.      Once the index is compiled you may view it on screen.  Select View the
  314.      Index from the Compile Menu.  The index will be displayed on the screen.
  315.      If you compiled the index in a previous session, you must select the source
  316.      file first to view the index.  Use the Pg Up and Pg Dn keys to view more of
  317.      the index.  Press Esc to exit.
  318.  
  319.      Printing the Index
  320.  
  321.      Once the index is compiled you may print it on your printer.  Assure that
  322.      your printer is on and on-line before printing.  Select Print the Index
  323.      from the Compile Menu.  If you compiled the index in a previous session,
  324.      you must select the source file first to print the index.
  325.      
  326.      ============================================================  Page 10 ===
  327.      Index Maker Menus
  328.      =========================================================================
  329.  
  330.      1.  Help Menu - choose this option to view the help information.
  331.  
  332.      2.  File Menu
  333.  
  334.              Open ASCII File to be Indexed - choose this option to open the
  335.                   source file to be indexed.
  336.              Disk Drive - choose this option to specify the default disk drive.
  337.                   This drive letter (A, B, C, D) will be saved from session to
  338.                   session until you change it.
  339.              Page Options - choose this to select if you wish page breaks to be
  340.                   determined by a set number of lines of text or by form feed
  341.                   characters.
  342.              Quit - choose this to end an Index Maker session.
  343.  
  344.      3.  Index Menu
  345.  
  346.              Compile the Index - reads the source file and creates an index
  347.                   based on the words in the Word List.
  348.              View the Index - allows you to view on screen a completed index.
  349.              Print the Index - allows you to print a completed index on your
  350.                   printer.
  351.  
  352.      4.  Word Menu
  353.  
  354.              Load Word List - loads a previously saved word list.
  355.              Create Word List - allows for the creation of words to be indexed
  356.                   in the source file.
  357.              View Word List - allows you to view the words in the word list.
  358.              Save Word List - allows you to save the word list in a disk file.
  359.  
  360.              Add Words Menu sub-menu
  361.  
  362.              Add Words to Current List - this option will allow you to add words
  363.                   to a previously loaded word list.
  364.              Start New Word List - allows you to begin a new word list.
  365.              Cancel - cancels adding words to the word list.
  366.  
  367.      
  368.      ===========================================================  Page 11 ===
  369.      Appendix
  370.      ========================================================================
  371.  
  372.      Index Structure
  373.  
  374.      Indexes created with Index Maker have the following structure:
  375.  
  376.      entry, 2, 3
  377.  
  378.      where [entry] is the word indexed followed by a comma.  Each page the word
  379.      is found on will be placed after the entry up to xx page citations.  The
  380.      index words will be sorted in ascending alphabetical order.  The word's
  381.      case will be exactly as it was entered in the word list.
  382.  
  383.      The maximum number of words allowed in a word list is 500.  The maximum
  384.      number of page citations for a word is 50.
  385.  
  386.      Program Files
  387.  
  388.      The following files should be on your Index Maker disk when you receive it:
  389.  
  390.      INDEXER.EXE     - the main program
  391.      INDEXER.DOC     - this documentation file
  392.      INDEXER.ADD     - file for storing program defaults
  393.      INDEXER.HLP     - the help file
  394.      AUTOEXEC.BAT    - a start up file used if starting the computer with your
  395.                        Index Maker disk.
  396.  
  397.      
  398.      ===========================================================  Page 12  ===
  399.      Registration Form
  400.      =========================================================================
  401.  
  402.      Index Maker - Version 2.0
  403.  
  404.      Itasca Softworks
  405.      Rt. 1, Box 408
  406.      Bagley, MN  56621
  407.  
  408.      Name _________________________________________________________
  409.  
  410.      Address ______________________________________________________
  411.  
  412.      City _________________________________________________________
  413.  
  414.      State _________________________________ Zip Code _____________
  415.  
  416.  
  417.      Where did you obtain Index Maker from?
  418.  
  419.      [  ] users group
  420.      [  ] telecommunications service
  421.      [  ] Public Domain/Shareware distributor ____________________
  422.      [  ] other _____________________________
  423.  
  424.  
  425.      Index Maker ..................................... $45.00      __________
  426.      Mail It! (mailing label program) ................ $15.00      __________
  427.      Small Breeder (dog & horse pedigrees) ........... $45.00      __________
  428.  
  429.      Minnesota Sales Tax      ........................ (6%)        __________
  430.  
  431.      Total ...........................................             __________
  432.  
  433.      Commments
  434.      ________________________________________________________________________
  435.  
  436.      ________________________________________________________________________
  437.  
  438.      ________________________________________________________________________
  439.  
  440.      Thank You!
  441.  
  442.      
  443.      ===========================================================  Page 13  ===
  444.      Index
  445.      =========================================================================
  446.  
  447.      backup, 2
  448.      case of words, 6, 11
  449.      compile, 4, 9, 10
  450.      create
  451.          index, 4
  452.          word lists, 6
  453.      disk drive, 4, 6, 9, 10
  454.      file 
  455.          extensions, 4, 5, 6, 7, 9
  456.          renaming, 4
  457.          selecting, 4, 5
  458.      form feeds 4, 8, 10
  459.      installation, 2
  460.      lines per page, 4, 8, 10
  461.      lists, 6, 7
  462.      loading, 6
  463.      menu description, 10
  464.      page options, 4, 8, 10
  465.      printing indexes,  9
  466.      re-compiling indexes, 4, 9
  467.      renaming files, 4
  468.      requirements, 2
  469.      saving, 
  470.           documents, 4 
  471.           word lists, 7
  472.      selecting files, 4, 5
  473.      source files, 3, 4, 5, 6, 9, 10
  474.      status, 3
  475.      structure of indexes, 11
  476.      viewing 
  477.           indexes, 9, 10
  478.           word lists, 7, 10
  479.      word lists, 6, 7
  480.  
  481.